home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / os2 / pmuue142.zip / PMUUE.DOC < prev    next >
Text File  |  1996-07-07  |  12KB  |  275 lines
  1.                               PMUUE 1.42
  2.             Presentation Manager Unix-to-Unix Encoder/Decoder
  3.                              July 7, 1996
  4.  
  5. What is PMUUE?
  6. ==============
  7.  
  8. PMUUE stands for Presentation Manager Unix-to-Unix Encoder/Decoder.
  9. It is used to encode and decode Unix-to-Unix encoded files (commonly
  10. known as uuencoded files.)
  11.  
  12. Using text only mail readers, it is not possible to send binary
  13. files through E-mail because of the possibility of non-ASCII
  14. charaters being lost or converted to other characters.  A utility,
  15. such as PMUUE, will convert a binary file into a set of ASCII
  16. characters (uuencoded format) which can be send through E-mail and
  17. converted back into binary format once the destination is reached.
  18.  
  19. The Disclaimer
  20. ==============
  21.  
  22. There is no warranty, expressed or implied, with this program.  THE
  23. AUTHOR IS NOT RESPONSIBLE FOR ANY DAMAGES INCURRED BY THE USE OF THIS
  24. PROGRAM.  Use at your own risk!
  25.  
  26. Distribution
  27. ============
  28.  
  29. This program may distribute this program as long as
  30.  
  31. a)      The archived file from which the program came from is distributed
  32.         and not altered in any way.
  33. b)      This program is not distributed with any commercial program except
  34.         for shareware or freeware collections of programs such as the
  35.         Walnut Creek CD-ROMs.
  36.  
  37. Quick Start
  38. ===========
  39.  
  40. Here are the basic steps to DECODE a UUENCODED file:
  41.  
  42. 1.  Select "File|Decode..." from the menu or press Ctrl-D.
  43.  
  44. 2.  Select ALL the files you want to decode.  If a binary file is split
  45.     between more than one UUENCODED file, you must make sure that those files
  46.     appear in the correct order and consecutively in the list box.  You can
  47.     only decode one directory at a time.  Press Ctrl-/ in the file list box
  48.     to select all files in the current directory.
  49.  
  50. 3.  Select the "OK" button.
  51.  
  52.     NOTE: If the decoding did not work properly, you may have to change some
  53.           of the settings in the "Preferences|Settings..." dialog box.
  54.  
  55. Here are the basic steps to ENCODE a binary file:
  56.  
  57. 1.  Select "File|Encode..." from the menu or press Ctrl-E.
  58.  
  59. 2.  Select ALL the files you want to encode.  You can only encode one
  60.     directory at a time.  Press Ctrl-/ in the file list box to select
  61.     all files in the current directory.
  62.  
  63. 3.  Select the "OK" button.
  64.  
  65.     NOTE: The format of the UUENCODED file is dependent on the current settings
  66.           of the "Preferences|Settings..." dialog box.
  67.  
  68. Parts of the PMUUE display
  69. ==========================
  70.  
  71. Besides the normal OS/2 system windows such as the title bar, the
  72. minimize and maximize buttons and the menu bar, there are two windows
  73. controlled by PMUUE and they are the log window and the status bar.
  74.  
  75. The log window is where any significant event has occured with regards
  76. to encoding or decoding a binary file.  Specifically, an entry is
  77. placed into the log window when:
  78.  
  79.    - A file is opened
  80.    - The process of encoding or decoding a file is started or finished
  81.  
  82. The log window keeps the last 500 events (by default) that has occured
  83. and deletes any log entries, starting from the oldest entry, that
  84. exceed the maximum number of entries allowed.  The log window
  85. automatically scrolls down to always show the latest event.
  86.  
  87. The status bar shows the last message sent to the log window but this
  88. might change in future versions to include a progress indicator.
  89.  
  90. A dialog box appears whenever an encoding or decoding process is
  91. complete, if desired.
  92.  
  93. The Menu Options
  94. ================
  95.  
  96. The File Menu
  97. -------------
  98.  
  99. The file menu allows the user to encode a file, decode a file, or exit
  100. the program.
  101.  
  102. When the user selects the "Encode..." menu option or presses Ctrl-E on
  103. the keyboard, the user is presented with a dialog box.  This dialog
  104. box allows the user to select the binary file that he or she wants to
  105. encode into uuencoded format.  The user can only select one or many
  106. files.  If the user selects "Cancel", the operation is aborted.  If
  107. the user selects "OK", then the encoding process is started.  A dialog
  108. box might appear when the encoding process is over.  Select "OK" to
  109. dismiss the dialog box.
  110.  
  111. The way the program encodes file can be determined by the Settings
  112. notebook.
  113.  
  114. When the user selects the "Decode..." menu option or presses Ctrl-D on
  115. the keyboard, the user is presented with a dialog box.  This dialog
  116. box allows the user to select the encoded file that he or she wants to
  117. decode back into a binary file.  The user can select as many files as
  118. he or she wants.  If the user select "Cancel", the operation is
  119. aborted.  If the user selects "OK", then the operation is started.
  120. Once the decoding process is finished, a dialog box may appear.
  121. Select "OK" to dismiss the dialog box.
  122.  
  123. An encoded file does NOT have to be stripped of extraneous text in
  124. order for PMUUE to decode it.  Also, the encoded file also does NOT
  125. have to be split up if it contains more than one uuencoded file.
  126. Even if the binary file is split into many uuencoded files, these
  127. uuencoded files do NOT have to be joined together into one file.
  128. PMUUE will (hopefully) be smart enough to determine which lines are
  129. encoded and which are not and when an encoded file starts and ends.
  130.  
  131. When the user select "Exit" or double-clicks on the system menu icon
  132. or selects "Close" from the system menu, the program will terminate.
  133.  
  134. The Preferences Menu
  135. --------------------
  136. The preferences has only one option, "Settings..." which will tell the
  137. program how to act in particular situations.  For a full explanation
  138. of the "Settings..." option, see "The Settings Notebook" elsewhere in
  139. this file.
  140.  
  141. The Help Menu
  142. -------------
  143. When the user selects "Help index...", the user is presented with all
  144. the major topics in the help file.
  145.  
  146. When the user selects "General Help...", the user sees the definitions
  147. of the major functions of this program.
  148.  
  149. When the user selects "Using Help...", a window with instructions on
  150. how to use help is presented.
  151.  
  152. When ther user select "Keys Help...", a window with valid keystrokes
  153. for the main window appears.
  154.  
  155. When the user select the "Product Information..." menu option, PMUUE
  156. will show a dialog showing the program name and version as well as
  157. other pertinent information about itself.
  158.  
  159. The Settings Notebook
  160. =====================
  161.  
  162. The settings notebook is divided into five pages: Notification, End of
  163. Line, Directories, Multi-part, and Miscellaneous.
  164.  
  165. The "Notification" page allows the user to select which output methods
  166. are used by the program.  The "Log" option specifies if the log window
  167. should be active.  The "Status Line" option specifies if the status
  168. line window should be used.  The "Message Box" option specifies if
  169. message windows should be used by the program for notification
  170. purposes.
  171.  
  172. The "End of Line" page specifies how an end-of-line marker should be
  173. like in a uuencoded file.  The "OS/2" option says that lines should
  174. end with a carriage return followed by a linefeed.  The "Unix" options
  175. says that lines should end with only a linefeed.
  176.  
  177. The "Directories" page specifies where the binary and uuencoded files
  178. should be and be placed.  The "Default Binary Directory" indicates
  179. where the binary files should be placed after decoding a uuencoded
  180. file.  The program will also look at that directory, by default, when
  181. starting up the "Encode..." menu option for the first time in the
  182. current session.  The "Default UUENCODE Directory" indicated where the
  183. uuencoded files should be placed after encoding a binary file.  The
  184. program will also look at that directory, by default, when starting up
  185. the "Decode..." menu option for the first in the currect session.
  186.  
  187. This page also has a "Default File Extension" file.  This field is
  188. used to add an extension to a uuencoded file when creating a uuencoded
  189. file except when the "Create multiple part encoding" option is used.
  190.  
  191. The "Multi-part" page specifies if multi-part uuencoded files should
  192. be created or not.  The "Create multiple part encoding" option
  193. indicates if PMUUE should split binary files into multiple uuencoded
  194. parts.  If this